GET /api/v2/scheduler/status/all
Description
Get the list of all discoveries. Returns list with basic information about all discovery jobs, regardless of their type and frequency - i.e. device discovery, cloud discovery, service flow discovery, and manual CMDB push.
| Name | Description | Type | Required | Default |
|---|
| Authorization | Bearer API token/key. The format is Bearer <API_key> | String | Yes | |
| orgId | The ID of the organization. The format is OrgId:OrgName | String | Yes | |
| siteId | The ID of the site. The format is SiteId:SiteName | String | Yes | |
Query Parameters
| Name | Description | Type | Required | Default |
|---|
| page | Page number, starting from 1 | String | No | 1 |
| size | Number of devices per page. Minimum size is 1 | String | No | 10 |
| sort | Sorting criteria in the format: property, (asc, desc). Multiple sort criteria are supported | String | No | |
| status | Discovery status. Allowed values are ACTIVE, ALREADY_UPDATING, BLOCKED, COMPLETE, CREATED, DECOMMISSIONED, DELETED, ERROR, EXCLUDED, EXECUTED, FAILED, FAILURE, HIDDEN, INACTIVE, INCOMPLETE, IN_PROGRESS, MISSED, MODIFIED, NOT_ALIVE, NOT_SCHEDULED, PARTIAL, PAUSED, PURGED, QUEUED, REDUCED, REJECTED, REQUESTED, RESCHEDULED, RESUMED, RETIRED, SCHEDULED, STARTED, SUBMITTED, SUCCESS, TIMEOUT, TOTAL, TRIGGERED, UNKNOWN, UNPURGED, UNREACHABLE, UPDATING | String | No | |
| triggerType | Discovery type - device discover (network, meraki), cloud discovery (AWS or Azure), service flow (pcap), or manual CMDB push. Allowed values are NETWORK_DISCOVERY, AZURE_DISCOVERY, AWS_DISCOVERY, PCAP_COLLECTION, CMDB_PUSH, CISCO_MERAKI_DISCOVERY | String | No | |
CURL Example
The below code snippet shows an example of the API call, where <NCE-IP>, <ORG-ID>, <SITE-ID> & <API-TOKEN> are variables.
curl --location 'https://<NCE-IP>/api/v2/scheduler/status/all?page=1&size=25&sort=schedule.startTime%2CDESC&status=IN_PROGRESS&triggerType=NETWORK_DISCOVERY' \
--header 'orgId: <ORG-ID>' \
--header 'siteId: <SITE-ID>' \
--header 'Authorization: Bearer <API-TOKEN>'
Response
Upon a successful request, the API returns Status code 200 with the following body:
| Name | Description | Type |
|---|
| pageInfo | General information about the page with returned results | Object |
| - number | Page number returned | Integer |
| - size | Page size returned | Integer |
| - totalRecords | Total number of records | Integer |
| pageData | List of records details | Array |
| - siteId | Site ID | String |
| - requestId | Discovery request ID | String |
| - triggerType | Discovery request trigger type | String |
| - startTime | Discovery request start time | String |
| - endTime | Discovery request end time | String |
| - interval | Discovery request recurrency interval in seconds | String |
| - status | Discovery request current status | String |
| - jobStatus | Discovery job details. Each element in the object is constructed by "status_name":<number_of_jobs> | Object |
| - requestName | Discovery request name | String |
| - totalJobs | Total number of jobs in the discovery request | String |
| - requestType | Discovery request type | String |
| - lastStarted | Discovery request last start time | String |
| - lastCompleted | Discovery request last completed time | String |
| - lastUpdateTime | Last time when the record was updated. The format is timeyyyy-MM-ddThh:mm:ss.tttZ | String |
| - progressStatus | Discovery request progress | Double |
GET /api/v2/scheduler/devices/{requestId}
Description
Get details about a particular discovery by request ID, including device, cloud, bulk, service flow, and manual CMDB schedules.
Path Parameters
| Name | Description | Type | Required | Default |
|---|
| requestId | Discovery request ID | String | Yes | |
| Name | Description | Type | Required | Default |
|---|
| Authorization | Bearer API token/key. The format is Bearer <API_key> | String | Yes | |
| orgId | The ID of the organization. The format is OrgId:OrgName | String | Yes | |
| siteId | The ID of the site. The format is SiteId:SiteName | String | Yes | |
CURL Example
The below code snippet shows an example of the API call, where <NCE-IP>, <ORG-ID>, <SITE-ID>, <API-TOKEN> & <REQUEST-ID> are variables.
curl --location 'https://<NCE-IP>/api/v2/scheduler/devices/<REQUEST-ID>' \
--header 'orgId: <ORG-ID>' \
--header 'siteId: <SITE-ID>' \
--header 'Authorization: Bearer <API-TOKEN>'
Response
Upon a successful request, the API returns Status code 200 with the following body:
| Name | Description | Type |
|---|
| ref | | String |
| docStatus | | String |
| lastUpdateTime | Last time when the record was updated. The format is timeyyyy-MM-ddThh:mm:ss.tttZ | String |
| lastCMDBUpdateTime | Last time the record was pushed to the CMDB. Applies for the manual CMDB push discovery record. The format is timeyyyy-MM-ddThh:mm:ss.tttZ | String |
| cmdbSysId | CMDB ID associated with the record. Applies for the manual CMDB push discovery record | String |
| updateLog | | String |
| orgId | Organization ID | String |
| siteId | Site ID | String |
| groupId | Group ID | String |
| requestId | Discovery request ID | String |
| requestName | Discovery request name | String |
| parent | Discovery request parent | String |
| ipRange | Discovery request IP range | Array of objects |
| - ipAddressFrom | Range IP start | String |
| - ipAddressTo | Range IP end | String |
| maskRange | Discovery request IP and mask | Array of objects |
| - ipAddressMask | Mask range IP start | String |
| - mask | Range mask | String |
| fqdnAddress | Discovery request list of FQDN v4 hosts | Array of objects |
| - deviceId | Device ID | String |
| - fqdn | Device fully qualified domain name (FQDN) | String |
| - hostName | Device hostname | String |
| - ip | Device IP | String |
| fqdnv6Address | Discovery request list of FQDN v6 hosts. The objects are with the same structure as for fqdnAddress | Array of objects |
| ignoredFqdnAddress | Discovery request list of FQDN v4 hosts that should be excluded | Array of strings |
| applications | Applications to be pushed by the manual CMDB push request | String |
| domain | Not in use | String |
| forest | Not in use | String |
| subDomain | Not in use | String |
| targetIp | Not in use | String |
| scomMethodology | Not in use | String |
POST /api/v2/scheduler/table/{requestId}
Description
Get the list of devices scanned by a particular device discovery by request ID.
Path Parameters
| Name | Description | Type | Required | Default |
|---|
| requestId | Discovery request ID | String | Yes | |
| Name | Description | Type | Required | Default |
|---|
| Authorization | Bearer API token/key. The format is Bearer <API_key> | String | Yes | |
| orgId | The ID of the organization. The format is OrgId:OrgName | String | Yes | |
| siteId | The ID of the site. The format is SiteId:SiteName | String | Yes | |
Query Parameters
| Name | Description | Type | Required | Default |
|---|
| currentPage | Page number, starting from 1 | String | Yes | 1 |
| pageSize | Number of devices per page. Minimum size is 1 | String | Yes | 25 |
| filterStatus | Reachability status to be filtered on | String | No | |
| sortField | Sort field | String | No | |
| sortOrder | Sort order. Allowed values asc, desc | String | No | asc |
CURL Example
The below code snippet shows an example of the API call, where <NCE-IP>, <ORG-ID>, <SITE-ID>, <API-TOKEN> & <REQUEST-ID> are variables.
curl --location --request POST 'https://<NCE-IP>/api/v2/scheduler/table/<REQUEST-ID>?currentPage=9&pageSize=25&filterStatus=&sortField=lastUpdateTime&sortOrder=asd' \
--header 'orgId: <ORG-ID>' \
--header 'siteId: <SITE-ID>' \
--header 'Authorization: Bearer <API-TOKEN>'
Response
Upon a successful request, the API returns Status code 200 with the following body:
| Name | Description | Type |
|---|
| pageInfo | General information about the page with returned results | Object |
| - number | Page number returned | Integer |
| - size | Page size returned | Integer |
| - totalRecords | Total number of records | Integer |
| pageData | List of records details | Array of objects |
| - ref | | String |
| - docStatus | | String |
| - lastUpdateTime | Last time when the record was updated. The format is timeyyyy-MM-ddThh:mm:ss.tttZ | String |
| - lastCMDBUpdateTime | Last time the record was pushed to the CMDB. The format is timeyyyy-MM-ddThh:mm:ss.tttZ | String |
| - cmdbSysId | CMDB ID associated with the record | String |
| - updateLog | | String |
| - orgId | Organization ID | String |
| - siteId | Site ID | String |
| - groupId | Group ID | String |
| - hostName | Device hostname | String |
| - fqdn | Device fully qualified domain name (FQDN) | String |
| - ipAddress | Device IPv4 | String |
| - ipv6Address | Device IPv6 | String |
| - subDomain | Not in use | String |
| - domain | Not in use | String |
| - forest | Not in use | String |
| - devType | Device type | String |
| - devSubType | Device subtype | String |
| - deviceId | Device ID | String |
| - reachableList | List of protocols able to connect with the device | Array of strings |
| - unreachableList | List of protocols able to connect with the device. Each element in the object is constructed by "protocol":"Failure_reason" | Object |
| - reachableMap | | String |
| - managers | List of device managers names | Array of strings |
| - reachability | Complete list of protocols attempted to discover the device, and reasons for success or failure. Each element in the object is constructed by "protocol":"reason" | Object |